[DOCS] Add new documentation checks to align with other OEP repositories#691
Open
sgolebiewski-intel wants to merge 3 commits intoopen-edge-platform:mainfrom
Open
Conversation
sgolebiewski-intel
requested review from
BaoHuiling,
OskarFiedot,
ZiningLi,
dmichalo,
jmotow,
marcin-wadolkowski,
mholowni,
msmiatac,
nszczygl9,
oonyshch,
pbartosik,
qianlongding,
tbujewsk,
tjanczak,
walidbarakat,
yangjianfeng1208 and
yunowo
as code owners
sgolebiewski-intel
force-pushed
the
add-documentation-checks-for-main
branch
from
2cf9520 to
98a68ad
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
sgolebiewski-intel
force-pushed
the
add-documentation-checks-for-main
branch
2 times, most recently
from
d02fdc9 to
b005d76
Compare
sgolebiewski-intel
force-pushed
the
add-documentation-checks-for-main
branch
3 times, most recently
from
f6a5eb1 to
ff4949c
Compare
sgolebiewski-intel
force-pushed
the
add-documentation-checks-for-main
branch
from
ff4949c to
edd6dd4
Compare
Signed-off-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
sgolebiewski-intel
force-pushed
the
add-documentation-checks-for-main
branch
from
edd6dd4 to
68b9d76
Compare
Signed-off-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
wiwaszko-intel
approved these changes
Mar 24, 2026
oonyshch
reviewed
Mar 24, 2026
Contributor
oonyshch
left a comment
oonyshch
left a comment
There was a problem hiding this comment.
Overall the approach looks good, please consider comments.
| DOCS_DIR: ${{ inputs.docs_directory }} | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 |
Contributor
There was a problem hiding this comment.
Please check whether this version v6.0.2 is right
| shell: bash | ||
| run: | | ||
| cd "${GITHUB_WORKSPACE}/${DOCS_DIR}" | ||
| wget https://docs.openedgeplatform.intel.com/template/template.tar.gz |
Contributor
There was a problem hiding this comment.
Please consider adding error handling and checksum verification for the downloaded tarball:
Suggested change
| wget https://docs.openedgeplatform.intel.com/template/template.tar.gz | |
| wget -q --show-progress https://docs.openedgeplatform.intel.com/template/template.tar.gz || { echo "Failed to download template"; exit 1; } | |
| # Verify checksum if available | |
| # sha256sum -c template.tar.gz.sha256 |
Co-authored-by: Olena (Lena) Onyshchenko <olena.onyshchenko@intel.com>
nszczygl9
requested changes
Mar 24, 2026
Contributor
nszczygl9
left a comment
nszczygl9
left a comment
There was a problem hiding this comment.
Do we need to separate documentation workflows into 2 files?
I think we can have one documentation-check.yaml and just add steps from docs-reusable-workflow.yaml in build-dlstreamer-documentation job.
| filter: | ||
| permissions: | ||
| contents: read # needed for actions/checkout | ||
| runs-on: ubuntu-latest |
Contributor
There was a problem hiding this comment.
please change runner group to dlstreamer
| persist-credentials: false | ||
| - name: Set paths filter | ||
| id: filter | ||
| uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 |
Contributor
There was a problem hiding this comment.
please update version to v4.0.1 and add comment with this version:
uses: dorny/paths-filter@fbd0ab8 #v4.0.1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add new documentation checks to GH to align with other repositiories in Open Edge Platform.
Fixes # (issue)
Any Newly Introduced Dependencies
Please describe any newly introduced 3rd party dependencies in this change. List their name, license information and how they are used in the project.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist: